# {{{pubName}}}
{{#appDescriptionWithNewLines}}
{{{.}}}
{{/appDescriptionWithNewLines}}

{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}

## Requirements

Dart 2.12 or later

## Installation & Usage

### pub.dev

```
dependencies:
  {{{pubName}}}:
    version: {{version}}
```

### Github

```
dependencies:
  {{{pubName}}}:
    git: https://{{{gitHost}}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
```

### Local
To use the package in your local drive, add the following dependency to your `pubspec.yaml`
```
dependencies:
  {{{pubName}}}:
    path: /path/to/{{{pubName}}}
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```dart{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}
{{> api_doc_example}}
{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
```

## Documentation for API Endpoints

All URIs are relative to *{{{basePath}}}*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{{classname}}}* | [**{{{operationId}}}**]({{{apiDocPath}}}/{{{classname}}}.md#{{{operationIdLowerCase}}}) | **{{{httpMethod}}}** {{{path}}} | {{{summary}}}
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}

## Documentation For Models

{{#models}}{{#model}} - [{{{classname}}}]({{{modelDocPath}}}/{{{classname}}}.md)
{{/model}}{{/models}}

{{^removeKonfigBranding}}
## Author
This Dart package is automatically generated by [Konfig](https://konfigthis.com)
{{/removeKonfigBranding}}